Step-by-step instructions for setting up Raspberry Pi Connect.
These procedures apply to Raspberry Pi 5, 4 or 3 with Raspberry Pi OS (64-Bit), (32-Bit) or (Legacy, 32-Bit).
General Notes
1. General:
The procedures below are optimized for setting up Raspberry Pi Connect on a Raspberry Pi 5, 4 or 3 with Raspberry Pi OS (64-Bit), (32-Bit) or (Legacy, 32-Bit) runnig bookworm (debian 12), trixie (debian 13) and above.
2. Raspberry Pi Connect:
Raspberry Pi Connect runs on Raspberry Pi OS bookworm (debian 12), trixie (debian 13) and above, older versions of Raspberry Pi OS are not supported.
Raspberry Pi Connect is installed by default in newer Raspberry Pi OS bookworm (debian 12) installations, all trixie (debian 13) and above installations, but is disabled by default.
Raspberry Pi Connect can be enabled and setup during SD card setup as an option in Raspberry Pi Imager 2.0 (released in November 2025) and above.
3. Internet access during setup:
Many of the steps below assume and require the target Raspberry Pi is connected to a network with access to the Internet.
4. Important note about Raspberry Pi Connect and TeamViewer:
Both screen sharing programs can exist on a Raspberry Pi without interfering with each other,
but the Raspberry Pi Connect screen sharing program requires Wayland (Remote Graphics Support A.K.A. compositor) and TeamViewer currently uses only the older X11 (compositor).
Raspberry Pi Connect Remote shell does not use the compositor and will work with either compositor in use.
It is posable to switch between Wayland and X11, however a reboot may be required.
Raspberry Pi Connect is recommended for typical users, while TeamViewer may be more attractive to more experienced users.
Notice about updates, upgrades and installations failing due to repository or network congestion or outages
Occasionally updates, upgrades and installations fail due to repository or network congestion or outages.
Sometimes there is an appropriate message saying as such, sometimes a missing file is reported, and sometimes there is just a failure message without an explanation.
When this occurs, simply run the command again.
If that does not solve the issues immediately, try again later.
Note: This tool only works with Raspberry Pi 4 or Pi 5. Raspberry Pi 3B+ and below have a ROM that can not be updated.
Check if the Raspberry Pi 4 or Pi 5 EEPROM should be updated
sudo rpi-eeprom-update -a
Update the Raspberry Pi 4 or Pi 5 EEPROM if required.
sudo raspi-config
Advance Options | Bootloader Version | Latest | Yes | Finish | Would you like to reboot now? | Yes
Install or update and setup Raspberry Pi Connect (Optional)
Notes:
Raspberry Pi Connect runs on Raspberry Pi OS bookworm (debian 12), trixie (debian 13) and above, older versions of Raspberry Pi OS are not supported.
Raspberry Pi Connect is installed by default in newer Raspberry Pi OS bookworm (debian 12) installations, all trixie (debian 13) and above installations, but is disabled by default.
However, it could have been enabled and setup during SD card setup as an option in Raspberry Pi Imager 2.0 (released in November 2025) and above.
If it was enabled and setup in Raspberry Pi Imager, it sould not require being enabled and setup here.
There is no danger in enabeling and seting it up it here as well.
See "General Notes" 4. near the top of this document.
Update Raspberry Pi OS and Components
Download latest package lists
sudo apt-get update -y
Download and install updated listed packages
sudo apt-get upgrade -y
Install or update Raspberry Pi Connect as required
sudo apt install rpi-connect
Setup Raspberry Pi Connect
rpi-connect signin
"rpi-connect signin" will return a message similar to:
"Complete sign in by visiting https://connect.raspberrypi.com/verify/XXXX-XXXX"
Paste or type the provided URL into a browser on any device.
"Sign in with Raspberry Pi ID" or "Create one for free"
The Raspberry Pi has been automticaly added to your account when you see the message below on the Raspberry Pi:
✓ Signed in
Connect to the target Raspberry Pi via Raspberry Pi Connect (Optional)